/*
 * $Id: ShemTextReader.java,v 1.1 2009/06/18 19:57:15 afaichun Exp $
 * 
 * Copyright (C) 2008 General Electric Company. All Rights Reserved.
 * 
 * This software is the confidential and proprietary information of the General
 * Electric Company (GE). You shall not disclose this software and shall use it
 * only in accordance with the terms of the license agreement you entered into
 * with GE.
 * 
 * GE MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
 * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. GE SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE
 * AS A RESULT OF USING, MODIFYING, OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES.
 */
package com.ge.healthcare.autosc.processor.shemjob.reader;

import java.io.InputStream;

import com.ge.healthcare.autosc.common.exceptions.BasicException;
import com.ge.healthcare.autosc.common.util.dataItem.IASCTextReader;
import com.ge.healthcare.autosc.processor.magmon.IMagnetMonitorProcessor;
import com.ge.healthcare.autosc.processor.magmon.MagnetMonitorUtility;

public interface ShemTextReader extends IASCTextReader {
    /**
     * Open the text reader.
     *
     * @param readerId Name used to identifier the reader.
     *
     * @param rawSource The raw input stream for reading the data.  It is the
     *  responsibility of the caller to make sure that this is buffered.
     *
     * @param helper Object providing the utility objects and methods.
     *
     * @param utility Utility class with magnet monitor methods.
     *
     * @param magmon The magnet monitor, which is used to get shem type and
     *  parameter configuration information for configurable readers.
     *
     * @exception AscServiceAbortException If an error is detected
     *  opening the reader.
     */
    public void open( String readerId,
               InputStream rawSource,
               MagnetMonitorUtility utility,
               IMagnetMonitorProcessor magmonProcessor ) throws BasicException;
}
